Skip to content
This repository was archived by the owner on Jan 23, 2026. It is now read-only.

Devmode: improve sourcemap when node_module is outside project#348

Merged
jhaynie merged 1 commit intomainfrom
improve-sourcemap
May 24, 2025
Merged

Devmode: improve sourcemap when node_module is outside project#348
jhaynie merged 1 commit intomainfrom
improve-sourcemap

Conversation

@jhaynie
Copy link
Copy Markdown
Member

@jhaynie jhaynie commented May 24, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Improved resolution of source file paths in stack traces, which may enhance accuracy when viewing error locations.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 24, 2025

Walkthrough

The update changes how the basedir variable is constructed within the Error.prepareStackTrace function in the source map shim. Now, if the source path starts with '../', the substring from filename is appended with '.agentuity' before being used as the base directory for path resolution.

Changes

File(s) Change Summary
internal/bundler/shim.go Modified logic for constructing basedir in Error.prepareStackTrace to append '.agentuity' if source starts with '../'.

Poem

In the warren of code, a path did shift,
With '.agentuity' now part of the gift.
When stack traces wander, and sources hide,
The bunny ensures the paths coincide.
Hop, hop, hooray, for directories true—
The source now finds its way to you!

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
internal/bundler/shim.go (2)

94-94: Logic looks correct for handling external node_modules, but consider code clarity.

The conditional logic correctly addresses the case where source paths start with '../', which aligns with the PR objective of improving sourcemap handling when node_modules is outside the project. The appended '.agentuity' string maintains consistency with the existing pattern used throughout the codebase.

However, the line is becoming complex with nested conditional logic. Consider extracting this logic for better readability.

Consider refactoring for improved readability:

-							const basedir = filename.substring(0, startIndex + offset) + (source.startsWith('../') ? '.agentuity' : '');
+							const baseSubstring = filename.substring(0, startIndex + offset);
+							const basedir = source.startsWith('../') ? baseSubstring + '.agentuity' : baseSubstring;

89-95: Consider adding documentation for complex sourcemap logic.

The sourcemap resolution logic is complex and handles multiple scenarios (different offsets, external dependencies, path construction). Adding inline comments explaining the purpose of each step would improve maintainability.

Consider adding comments to explain the logic:

						if (pos && pos.source) {
							const startIndex = filename.indexOf('.agentuity/');
+							// Determine offset based on whether we're dealing with node_modules
							const offset = filename.includes('../node_modules/') ? 11 : 0;
							const sourceOffset = pos.source.indexOf('src/');
							const source = pos.source.substring(sourceOffset);
+							// Append .agentuity suffix when source references parent directories
							const basedir = filename.substring(0, startIndex + offset) + (source.startsWith('../') ? '.agentuity' : '');
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 62923bf and 9a13788.

📒 Files selected for processing (1)
  • internal/bundler/shim.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Test CLI Upgrade Path (windows-latest)
  • GitHub Check: Analyze (go)

@jhaynie jhaynie merged commit deb31c9 into main May 24, 2025
14 checks passed
@jhaynie jhaynie deleted the improve-sourcemap branch May 24, 2025 15:37
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant